interface ProjectSourceVersionProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.CodeBuild.CfnProject.ProjectSourceVersionProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awscodebuild#CfnProject_ProjectSourceVersionProperty |
Java | software.amazon.awscdk.services.codebuild.CfnProject.ProjectSourceVersionProperty |
Python | aws_cdk.aws_codebuild.CfnProject.ProjectSourceVersionProperty |
TypeScript | aws-cdk-lib » aws_codebuild » CfnProject » ProjectSourceVersionProperty |
A source identifier and its corresponding version.
Example
// 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
Name | Type | Description |
---|---|---|
source | string | An identifier for a source in the build project. |
source | string | The source version for the corresponding source identifier. If specified, must be one of:. |
sourceIdentifier
Type:
string
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.
sourceVersion?
Type:
string
(optional)
The source version for the corresponding source identifier. If specified, must be one of:.
- 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 .