aws-cdk-lib.aws_codecommit.CfnRepository.CodeProperty

interface CodeProperty

LanguageType name
.NETAmazon.CDK.AWS.CodeCommit.CfnRepository.CodeProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodecommit#CfnRepository_CodeProperty
Javasoftware.amazon.awscdk.services.codecommit.CfnRepository.CodeProperty
Pythonaws_cdk.aws_codecommit.CfnRepository.CodeProperty
TypeScript aws-cdk-lib » aws_codecommit » CfnRepository » CodeProperty

Information about code to be committed.

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 codeProperty: codecommit.CfnRepository.CodeProperty = {
  s3: {
    bucket: 'bucket',
    key: 'key',

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

  // the properties below are optional
  branchName: 'branchName',
};

Properties

NameTypeDescription
s3IResolvable | S3PropertyInformation about the Amazon S3 bucket that contains a ZIP file of code to be committed to the repository.
branchName?stringOptional.

s3

Type: IResolvable | S3Property

Information about the Amazon S3 bucket that contains a ZIP file of code to be committed to the repository.

Changes to this property are ignored after initial resource creation.


branchName?

Type: string (optional)

Optional.

Specifies a branch name to be used as the default branch when importing code into a repository on initial creation. If this property is not set, the name main will be used for the default branch for the repository. Changes to this property are ignored after initial resource creation. We recommend using this parameter to set the name to main to align with the default behavior of CodeCommit unless another name is needed.