software.amazon.awscdk.services.codepipeline.actions

Class CodeCommitSourceAction.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.actions.CodeCommitSourceAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CodeCommitSourceAction>

Enclosing class:

CodeCommitSourceAction

@Stability(value=Stable)
public static final class CodeCommitSourceAction.Builder
extends Object
implements software.amazon.jsii.Builder<CodeCommitSourceAction>

A fluent builder for CodeCommitSourceAction.

Method Summary

Modifier and Type	Method and Description
CodeCommitSourceAction.Builder	actionName(String actionName) The physical, human-readable name of the Action.
CodeCommitSourceAction.Builder	branch(String branch) Default: 'master'
CodeCommitSourceAction	build()
CodeCommitSourceAction.Builder	codeBuildCloneOutput(Boolean codeBuildCloneOutput) 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.
static CodeCommitSourceAction.Builder	create()
CodeCommitSourceAction.Builder	eventRole(IRole eventRole) Role to be used by on commit event rule.
CodeCommitSourceAction.Builder	output(Artifact output)
CodeCommitSourceAction.Builder	repository(IRepository repository) The CodeCommit repository.
CodeCommitSourceAction.Builder	role(IRole role) The Role in which context's this Action will be executing in.
CodeCommitSourceAction.Builder	runOrder(Number runOrder) The runOrder property for this Action.
CodeCommitSourceAction.Builder	trigger(CodeCommitTrigger trigger) How should CodePipeline detect source changes for this Action.
CodeCommitSourceAction.Builder	variablesNamespace(String variablesNamespace) The name of the namespace to use for variables emitted by this action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CodeCommitSourceAction.Builder create()

Returns:

a new instance of CodeCommitSourceAction.Builder.

actionName

@Stability(value=Stable)
public CodeCommitSourceAction.Builder actionName(String actionName)

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required.

Returns:

this

runOrder

@Stability(value=Stable)
public CodeCommitSourceAction.Builder runOrder(Number runOrder)

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Default: 1

Parameters:

runOrder - The runOrder property for this Action. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

variablesNamespace

@Stability(value=Stable)
public CodeCommitSourceAction.Builder variablesNamespace(String variablesNamespace)

The name of the namespace to use for variables emitted by this action.

Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

Parameters:

variablesNamespace - The name of the namespace to use for variables emitted by this action. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public CodeCommitSourceAction.Builder role(IRole role)

The Role in which context's this Action will be executing in.

The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default: a new Role will be generated

Parameters:

role - The Role in which context's this Action will be executing in. This parameter is required.

Returns:

this

output

@Stability(value=Stable)
public CodeCommitSourceAction.Builder output(Artifact output)

Parameters:

output - This parameter is required.

Returns:

this

repository

@Stability(value=Stable)
public CodeCommitSourceAction.Builder repository(IRepository repository)

The CodeCommit repository.

Parameters:

repository - The CodeCommit repository. This parameter is required.

Returns:

this

branch

@Stability(value=Stable)
public CodeCommitSourceAction.Builder branch(String branch)

Default: 'master'

Parameters:

branch - This parameter is required.

Returns:

this

codeBuildCloneOutput

@Stability(value=Stable)
public CodeCommitSourceAction.Builder codeBuildCloneOutput(Boolean codeBuildCloneOutput)

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 {@link output}.

Default: false

Parameters:

codeBuildCloneOutput - 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. This parameter is required.

Returns:

this

See Also:

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

eventRole

@Stability(value=Stable)
public CodeCommitSourceAction.Builder eventRole(IRole eventRole)

Role to be used by on commit event rule.

Used only when trigger value is CodeCommitTrigger.EVENTS.

Default: a new role will be created.

Parameters:

eventRole - Role to be used by on commit event rule. This parameter is required.

Returns:

this

trigger

@Stability(value=Stable)
public CodeCommitSourceAction.Builder trigger(CodeCommitTrigger trigger)

How should CodePipeline detect source changes for this Action.

Default: CodeCommitTrigger.EVENTS

Parameters:

trigger - How should CodePipeline detect source changes for this Action. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CodeCommitSourceAction build()

Specified by:

build in interface software.amazon.jsii.Builder<CodeCommitSourceAction>