software.amazon.awscdk.services.codecommit

Class CfnRepository

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.133Z")
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 and Description
static 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 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 java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRepository(Construct scope, java.lang.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 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	getAttrCloneUrlHttp() When you pass the logical ID of this resource, the function returns the URL to use for cloning the repository over HTTPS.
java.lang.String	getAttrCloneUrlSsh() When you pass the logical ID of this resource, the function returns the URL to use for cloning the repository over SSH.
java.lang.String	getAttrName() When you pass the logical ID of this resource, the function returns the repository's name.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getCode() Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
java.lang.String	getRepositoryDescription() A comment or description about the new repository.
java.lang.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.
java.lang.Object	getTriggers() The JSON block of configuration information for each trigger.
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	setCode(CfnRepository.CodeProperty value) Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
void	setCode(IResolvable value) Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
void	setRepositoryDescription(java.lang.String value) A comment or description about the new repository.
void	setRepositoryName(java.lang.String value) The name of the new repository to be created.
void	setTriggers(IResolvable value) The JSON block of configuration information for each trigger.
void	setTriggers(java.util.List<java.lang.Object> 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 java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnRepository(Construct scope,
                     java.lang.String id,
                     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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getAttrCloneUrlHttp

public java.lang.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

public java.lang.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

public java.lang.String getAttrName()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

getRepositoryName

public java.lang.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

public void setRepositoryName(java.lang.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

public java.lang.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

public void setCode(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

public void setCode(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

public java.lang.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

public void setRepositoryDescription(java.lang.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

public java.lang.Object getTriggers()

The JSON block of configuration information for each trigger.

setTriggers

public void setTriggers(IResolvable value)

The JSON block of configuration information for each trigger.

setTriggers

public void setTriggers(java.util.List<java.lang.Object> value)

The JSON block of configuration information for each trigger.