Show / Hide Table of Contents

Class CodeCommitSourceProps

Construction properties for {@link CodeCommitSource}.

Inheritance
System.Object
CodeCommitSourceProps
Implements
ICodeCommitSourceProps
ISourceProps
Namespace: Amazon.CDK.AWS.CodeBuild
Assembly: Amazon.CDK.AWS.CodeBuild.dll
Syntax (csharp)
public class CodeCommitSourceProps : Object, ICodeCommitSourceProps, ISourceProps
Syntax (vb)
Public Class CodeCommitSourceProps
    Inherits Object
    Implements ICodeCommitSourceProps, ISourceProps

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
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
"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.

Repository

public IRepository Repository { get; set; }
Property Value

IRepository

Implements

ICodeCommitSourceProps
ISourceProps
Back to top Generated by DocFX