Package software.amazon.awscdk.services.codecommit

Interface CfnRepositoryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRepositoryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:14.129Z")
@Stability(Stable)
public interface CfnRepositoryProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRepository.

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.*;
 CfnRepositoryProps cfnRepositoryProps = CfnRepositoryProps.builder()
         .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())
         .kmsKeyId("kmsKeyId")
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRepositoryProps.Builder	A builder for CfnRepositoryProps
static final class	CfnRepositoryProps.Jsii$Proxy	An implementation for CfnRepositoryProps

Method Summary

Modifier and Type	Method	Description
static CfnRepositoryProps.Builder	builder()
default Object	getCode()	Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
default String	getKmsKeyId()	The ID of the AWS Key Management Service encryption key used to encrypt and decrypt the repository.
default String	getRepositoryDescription()	A comment or description about the new repository.
String	getRepositoryName()	The name of the new repository to be created.
default List<CfnTag>	getTags()	One or more tag key-value pairs to use when tagging this repository.
default Object	getTriggers()	The JSON block of configuration information for each trigger.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRepositoryName

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-repositoryname

getCode

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-code

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The ID of the AWS Key Management Service encryption key used to encrypt and decrypt the repository.

The input can be the full ARN, the key ID, or the key alias. For more information, see Finding the key ID and key ARN .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-kmskeyid

getRepositoryDescription

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-repositorydescription

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-tags

getTriggers

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

The JSON block of configuration information for each trigger.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-triggers

builder

@Stability(Stable)
static CfnRepositoryProps.Builder builder()

Returns:

a CfnRepositoryProps.Builder of CfnRepositoryProps