Package software.amazon.awscdk.pipelines

Interface CodeCommitSourceOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CodeCommitSourceOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.268Z")
@Stability(Stable)
public interface CodeCommitSourceOptions
extends software.amazon.jsii.JsiiSerializable

Configuration options for a CodeCommit source.

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.codepipeline.actions.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.pipelines.*;
 Role role;
 CodeCommitSourceOptions codeCommitSourceOptions = CodeCommitSourceOptions.builder()
         .actionName("actionName")
         .codeBuildCloneOutput(false)
         .eventRole(role)
         .trigger(CodeCommitTrigger.NONE)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CodeCommitSourceOptions.Builder	builder()
default String	getActionName()	The action name used for this source in the CodePipeline.
default Boolean	getCodeBuildCloneOutput()	If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).
default IRole	getEventRole()	Role to be used by on commit event rule.
default CodeCommitTrigger	getTrigger()	How should CodePipeline detect source changes for this Action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionName

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

The action name used for this source in the CodePipeline.

Default: - The repository name

getCodeBuildCloneOutput

@Stability(Stable)
@Nullable
default Boolean getCodeBuildCloneOutput()

If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).

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 Also:

• https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeCommit.html

getEventRole

@Stability(Stable)
@Nullable
default IRole getEventRole()

Role to be used by on commit event rule.

Used only when trigger value is CodeCommitTrigger.EVENTS.

Default: a new role will be created.

getTrigger

@Stability(Stable)
@Nullable
default CodeCommitTrigger getTrigger()

How should CodePipeline detect source changes for this Action.

Default: CodeCommitTrigger.EVENTS

builder

@Stability(Stable)
static CodeCommitSourceOptions.Builder builder()

Returns:

a CodeCommitSourceOptions.Builder of CodeCommitSourceOptions