Class CodeCommitSourceOptions
Configuration options for a CodeCommit source.
Inheritance
Implements
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CodeCommitSourceOptions : Object, ICodeCommitSourceOptions
Syntax (vb)
Public Class CodeCommitSourceOptions
Inherits Object
Implements ICodeCommitSourceOptions
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodePipeline.Actions;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.Pipelines;
Role role;
var codeCommitSourceOptions = new CodeCommitSourceOptions {
ActionName = "actionName",
CodeBuildCloneOutput = false,
EventRole = role,
Trigger = CodeCommitTrigger.NONE
};
Synopsis
Constructors
CodeCommitSourceOptions() |
Properties
ActionName | The action name used for this source in the CodePipeline. |
CodeBuildCloneOutput | If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files). |
EventRole | Role to be used by on commit event rule. |
Trigger | How should CodePipeline detect source changes for this Action. |
Constructors
CodeCommitSourceOptions()
public CodeCommitSourceOptions()
Properties
ActionName
The action name used for this source in the CodePipeline.
public string ActionName { get; set; }
Property Value
System.String
Remarks
Default: - The repository name
CodeBuildCloneOutput
If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).
public Nullable<bool> CodeBuildCloneOutput { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
This provides access to repository history, and retains symlinks (symlinks would otherwise be removed by CodePipeline).
Note: if this option is true, only CodeBuild jobs can use the output artifact.
Default: false
See: https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeCommit.html
EventRole
Role to be used by on commit event rule.
public IRole EventRole { get; set; }
Property Value
Remarks
Used only when trigger value is CodeCommitTrigger.EVENTS.
Default: a new role will be created.
Trigger
How should CodePipeline detect source changes for this Action.
public Nullable<CodeCommitTrigger> Trigger { get; set; }
Property Value
System.Nullable<CodeCommitTrigger>
Remarks
Default: CodeCommitTrigger.EVENTS