Skip to content
v2.277.0

ProjectSourceVersionProperty Struct ​

A source identifier and its corresponding version.

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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codebuild as codebuild

project_source_version_property = codebuild.CfnProject.ProjectSourceVersionProperty(
    source_identifier="sourceIdentifier",

    # the properties below are optional
    source_version="sourceVersion"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codebuild.*;

ProjectSourceVersionProperty projectSourceVersionProperty = ProjectSourceVersionProperty.builder()
        .sourceIdentifier("sourceIdentifier")

        // the properties below are optional
        .sourceVersion("sourceVersion")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeBuild;

var projectSourceVersionProperty = new ProjectSourceVersionProperty {
    SourceIdentifier = "sourceIdentifier",

    // the properties below are optional
    SourceVersion = "sourceVersion"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

projectSourceVersionProperty := &ProjectSourceVersionProperty{
	SourceIdentifier: jsii.String("sourceIdentifier"),

	// the properties below are optional
	SourceVersion: jsii.String("sourceVersion"),
}

Properties ​

sourceIdentifierstringsource_identifierstrsourceIdentifierStringSourceIdentifierstringSourceIdentifier*string required #
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.

sourceVersionoptionalstringsource_versionoptionalstrsourceVersionoptionalStringSourceVersionoptionalstringSourceVersionoptional*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 .