Package software.amazon.awscdk.services.codepipeline.actions

Interface CodeCommitSourceActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CodeCommitSourceActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-07T10:36:04.093Z")
@Stability(Stable)
public interface CodeCommitSourceActionProps
extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps

Construction properties of the CodeCommitSourceAction CodeCommit source CodePipeline Action.

Example:

 // Source stage: read from repository
 Repository repo = Repository.Builder.create(stack, "TemplateRepo")
         .repositoryName("template-repo")
         .build();
 Artifact sourceOutput = new Artifact("SourceArtifact");
 CodeCommitSourceAction source = CodeCommitSourceAction.Builder.create()
         .actionName("Source")
         .repository(repo)
         .output(sourceOutput)
         .trigger(CodeCommitTrigger.POLL)
         .build();
 Map<String, Object> sourceStage = Map.of(
         "stageName", "Source",
         "actions", List.of(source));
 // Deployment stage: create and deploy changeset with manual approval
 String stackName = "OurStack";
 String changeSetName = "StagedChangeSet";
 Map<String, Object> prodStage = Map.of(
         "stageName", "Deploy",
         "actions", List.of(
             CloudFormationCreateReplaceChangeSetAction.Builder.create()
                     .actionName("PrepareChanges")
                     .stackName(stackName)
                     .changeSetName(changeSetName)
                     .adminPermissions(true)
                     .templatePath(sourceOutput.atPath("template.yaml"))
                     .runOrder(1)
                     .build(),
             ManualApprovalAction.Builder.create()
                     .actionName("ApproveChanges")
                     .runOrder(2)
                     .build(),
             CloudFormationExecuteChangeSetAction.Builder.create()
                     .actionName("ExecuteChanges")
                     .stackName(stackName)
                     .changeSetName(changeSetName)
                     .runOrder(3)
                     .build()));
 Pipeline.Builder.create(stack, "Pipeline")
         .crossAccountKeys(true)
         .stages(List.of(sourceStage, prodStage))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CodeCommitSourceActionProps.Builder	builder()
default String	getBranch()	Default: 'master'
default Boolean	getCodeBuildCloneOutput()	Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building.
default ICustomEventRule	getCustomEventRule()	You can pass a customEventRule to set up a custom event rule for the CodeCommit source action.
default IRole	getEventRole()	Role to be used by on commit event rule.
Artifact	getOutput()
IRepository	getRepository()	The CodeCommit repository.
default CodeCommitTrigger	getTrigger()	How should CodePipeline detect source changes for this Action.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonAwsActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOutput

@Stability(Stable)
@NotNull
Artifact getOutput()

getRepository

@Stability(Stable)
@NotNull
IRepository getRepository()

The CodeCommit repository.

getBranch

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

Default: 'master'

getCodeBuildCloneOutput

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

Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building.

Note: if this option is true, then only CodeBuild actions can use the resulting output.

Default: false

See Also:

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

getCustomEventRule

@Stability(Stable)
@Nullable
default ICustomEventRule getCustomEventRule()

You can pass a customEventRule to set up a custom event rule for the CodeCommit source action.

You must provide the eventPattern and target properties in the customEventRule object. Check which eventPattern to use: https://docs.aws.amazon.com/codecommit/latest/userguide/monitoring-events.html

Default: Event rule which is triggered by CodeCommit repository on commit

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 CodeCommitSourceActionProps.Builder builder()

Returns:

a CodeCommitSourceActionProps.Builder of CodeCommitSourceActionProps