AWS CDK Reference

Appearance

v2.274.0

ProjectSourceVersionProperty Struct ​

A source identifier and its corresponding version.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const projectSourceVersionProperty: codebuild.CfnProject.ProjectSourceVersionProperty = {
  sourceIdentifier: 'sourceIdentifier',

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

Properties ​

sourceIdentifierstringsource_identifierstrsourceIdentifierStringSourceIdentifierstringSourceIdentifier*stringrequired#
An identifier for a source in the build project.

The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.

sourceVersionstringsource_versionstrsourceVersionStringSourceVersionstringSourceVersion*string#
The source version for the corresponding source identifier. If specified, must be one of:.
notes
  • For CodeCommit: the commit ID, branch, or Git tag to use.
  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25 ). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
  • For GitLab: the commit ID, branch, or Git tag to use.
  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
  • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .