Package software.amazon.awscdk.services.codecommit

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.codecommit.CfnRepository

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:38.227Z")
@Stability(Stable)
public class CfnRepository
extends CfnResource
implements IInspectable

A CloudFormation AWS::CodeCommit::Repository.

Creates a new, empty repository.

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.codecommit.*;
 CfnRepository cfnRepository = CfnRepository.Builder.create(this, "MyCfnRepository")
         .repositoryName("repositoryName")
         // the properties below are optional
         .code(CodeProperty.builder()
                 .s3(S3Property.builder()
                         .bucket("bucket")
                         .key("key")
                         // the properties below are optional
                         .objectVersion("objectVersion")
                         .build())
                 // the properties below are optional
                 .branchName("branchName")
                 .build())
         .repositoryDescription("repositoryDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .triggers(List.of(RepositoryTriggerProperty.builder()
                 .destinationArn("destinationArn")
                 .events(List.of("events"))
                 .name("name")
                 // the properties below are optional
                 .branches(List.of("branches"))
                 .customData("customData")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnRepository.Builder	A fluent builder for CfnRepository.
static interface	CfnRepository.CodeProperty	Information about code to be committed.
static interface	CfnRepository.RepositoryTriggerProperty	Information about a trigger for a repository.
static interface	CfnRepository.S3Property	Information about the Amazon S3 bucket that contains the code that will be committed to the new repository.

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.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository.
String	getAttrCloneUrlHttp()	When you pass the logical ID of this resource, the function returns the URL to use for cloning the repository over HTTPS.
String	getAttrCloneUrlSsh()	When you pass the logical ID of this resource, the function returns the URL to use for cloning the repository over SSH.
String	getAttrName()	When you pass the logical ID of this resource, the function returns the repository's name.
protected Map<String,Object>	getCfnProperties()
Object	getCode()	Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
String	getRepositoryDescription()	A comment or description about the new repository.
String	getRepositoryName()	The name of the new repository to be created.
TagManager	getTags()	One or more tag key-value pairs to use when tagging this repository.
Object	getTriggers()	The JSON block of configuration information for each trigger.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCode(IResolvable value)	Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
void	setCode(CfnRepository.CodeProperty value)	Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
void	setRepositoryDescription(String value)	A comment or description about the new repository.
void	setRepositoryName(String value)	The name of the new repository to be created.
void	setTriggers(List<Object> value)	The JSON block of configuration information for each trigger.
void	setTriggers(IResolvable value)	The JSON block of configuration information for each trigger.

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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnRepository

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

CfnRepository

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

CfnRepository

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

Create a new AWS::CodeCommit::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 Details

inspect

@Stability(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(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(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.

getAttrCloneUrlHttp

@Stability(Stable)
@NotNull
public String getAttrCloneUrlHttp()

When you pass the logical ID of this resource, the function returns the URL to use for cloning the repository over HTTPS.

getAttrCloneUrlSsh

@Stability(Stable)
@NotNull
public String getAttrCloneUrlSsh()

When you pass the logical ID of this resource, the function returns the URL to use for cloning the repository over SSH.

getAttrName

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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

One or more tag key-value pairs to use when tagging this repository.

getRepositoryName

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

The name of the new repository to be created.

The repository name must be unique across the calling AWS account . Repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For more information about the limits on repository names, see Quotas in the AWS CodeCommit User Guide . The suffix .git is prohibited.

setRepositoryName

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

The name of the new repository to be created.

The repository name must be unique across the calling AWS account . Repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For more information about the limits on repository names, see Quotas in the AWS CodeCommit User Guide . The suffix .git is prohibited.

getCode

@Stability(Stable)
@Nullable
public Object getCode()

Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.

Information about code is only used in resource creation. Updates to a stack will not reflect changes made to code properties after initial resource creation.

You can only use this property to add code when creating a repository with a AWS CloudFormation template at creation time. This property cannot be used for updating code to an existing repository.

setCode

@Stability(Stable)
public void setCode(@Nullable
 CfnRepository.CodeProperty value)

Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.

Information about code is only used in resource creation. Updates to a stack will not reflect changes made to code properties after initial resource creation.

You can only use this property to add code when creating a repository with a AWS CloudFormation template at creation time. This property cannot be used for updating code to an existing repository.

setCode

@Stability(Stable)
public void setCode(@Nullable
 IResolvable value)

Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.

Information about code is only used in resource creation. Updates to a stack will not reflect changes made to code properties after initial resource creation.

You can only use this property to add code when creating a repository with a AWS CloudFormation template at creation time. This property cannot be used for updating code to an existing repository.

getRepositoryDescription

@Stability(Stable)
@Nullable
public String getRepositoryDescription()

A comment or description about the new repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage.

setRepositoryDescription

@Stability(Stable)
public void setRepositoryDescription(@Nullable
 String value)

A comment or description about the new repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage.

getTriggers

@Stability(Stable)
@Nullable
public Object getTriggers()

The JSON block of configuration information for each trigger.

setTriggers

@Stability(Stable)
public void setTriggers(@Nullable
 IResolvable value)

The JSON block of configuration information for each trigger.

setTriggers

@Stability(Stable)
public void setTriggers(@Nullable
 List<Object> value)

The JSON block of configuration information for each trigger.