interface CfnRepositoryProps

Language	Type name
.NET	`Amazon.CDK.AWS.CodeCommit.CfnRepositoryProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscodecommit#CfnRepositoryProps`
Java	`software.amazon.awscdk.services.codecommit.CfnRepositoryProps`
Python	`aws_cdk.aws_codecommit.CfnRepositoryProps`
TypeScript	`aws-cdk-lib` » `aws_codecommit` » `CfnRepositoryProps`

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 { aws_codecommit as codecommit } from 'aws-cdk-lib';
const cfnRepositoryProps: codecommit.CfnRepositoryProps = {
  repositoryName: 'repositoryName',

  // the properties below are optional
  code: {
    s3: {
      bucket: 'bucket',
      key: 'key',

      // the properties below are optional
      objectVersion: 'objectVersion',
    },

    // the properties below are optional
    branchName: 'branchName',
  },
  kmsKeyId: 'kmsKeyId',
  repositoryDescription: 'repositoryDescription',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  triggers: [{
    destinationArn: 'destinationArn',
    events: ['events'],
    name: 'name',

    // the properties below are optional
    branches: ['branches'],
    customData: 'customData',
  }],
};

Properties

Name	Type	Description
repositoryName	`string`	The name of the new repository to be created.
code?	`IResolvable` `\|` `CodeProperty`	Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
kmsKeyId?	`string`	The ID of the AWS Key Management Service encryption key used to encrypt and decrypt the repository.
repositoryDescription?	`string`	A comment or description about the new repository.
tags?	`CfnTag[]`	One or more tag key-value pairs to use when tagging this repository.
triggers?	`IResolvable` `\|` `IResolvable` `\|` `RepositoryTriggerProperty[]`	The JSON block of configuration information for each trigger.

repositoryName

Type: string

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.

code?

Type: IResolvable | CodeProperty (optional)

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.

kmsKeyId?

Type: string (optional)

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 .

repositoryDescription?

Type: string (optional)

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.

tags?

Type: CfnTag[] (optional)

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

triggers?

Type: IResolvable | IResolvable | RepositoryTriggerProperty[] (optional)

The JSON block of configuration information for each trigger.