Package software.amazon.awscdk.services.codebuild

Interface CfnProject.ProjectSourceVersionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProject.ProjectSourceVersionProperty.Jsii$Proxy

Enclosing class:

CfnProject

@Stability(Stable)
public static interface CfnProject.ProjectSourceVersionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.codebuild.*;
 ProjectSourceVersionProperty projectSourceVersionProperty = ProjectSourceVersionProperty.builder()
         .sourceIdentifier("sourceIdentifier")
         // the properties below are optional
         .sourceVersion("sourceVersion")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProject.ProjectSourceVersionProperty.Builder	A builder for CfnProject.ProjectSourceVersionProperty
static final class	CfnProject.ProjectSourceVersionProperty.Jsii$Proxy	An implementation for CfnProject.ProjectSourceVersionProperty

Method Summary

Modifier and Type	Method	Description
static CfnProject.ProjectSourceVersionProperty.Builder	builder()
String	getSourceIdentifier()	An identifier for a source in the build project.
default String	getSourceVersion()	The source version for the corresponding source identifier.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSourceIdentifier

@Stability(Stable)
@NotNull
String getSourceIdentifier()

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.

getSourceVersion

@Stability(Stable)
@Nullable
default String getSourceVersion()

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

builder

@Stability(Stable)
static CfnProject.ProjectSourceVersionProperty.Builder builder()

Returns:

a CfnProject.ProjectSourceVersionProperty.Builder of CfnProject.ProjectSourceVersionProperty