Class CodeCommitSourceProps
Construction properties for CodeCommitSource
.
Inheritance
Namespace: Amazon.CDK.AWS.CodeBuild
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CodeCommitSourceProps : Object, ICodeCommitSourceProps, ISourceProps
Syntax (vb)
Public Class CodeCommitSourceProps
Inherits Object
Implements ICodeCommitSourceProps, ISourceProps
Remarks
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.CodeCommit;
Repository repo;
Bucket bucket;
var project = new Project(this, "MyProject", new ProjectProps {
SecondarySources = new [] { Source.CodeCommit(new CodeCommitSourceProps {
Identifier = "source2",
Repository = repo
}) },
SecondaryArtifacts = new [] { Artifacts.S3(new S3ArtifactsProps {
Identifier = "artifact2",
Bucket = bucket,
Path = "some/path",
Name = "file.zip"
}) }
});
Synopsis
Constructors
CodeCommitSourceProps() |
Properties
BranchOrRef | The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. |
CloneDepth | The depth of history to download. |
FetchSubmodules | Whether to fetch submodules while cloning git repo. |
Identifier | The source identifier. |
Repository |
Constructors
CodeCommitSourceProps()
public CodeCommitSourceProps()
Properties
BranchOrRef
The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build.
public string BranchOrRef { get; set; }
Property Value
System.String
Remarks
Default: the default branch's HEAD commit ID is used
Examples
"mybranch";
CloneDepth
The depth of history to download.
public Nullable<double> CloneDepth { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build of the project.
FetchSubmodules
Whether to fetch submodules while cloning git repo.
public Nullable<bool> FetchSubmodules { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Identifier
The source identifier.
public string Identifier { get; set; }
Property Value
System.String
Remarks
This property is required on secondary sources.