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

Class CodeCommitSourceActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CodeCommitSourceActionProps>

Enclosing interface:

CodeCommitSourceActionProps

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

A builder for CodeCommitSourceActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CodeCommitSourceActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
CodeCommitSourceActionProps.Builder	branch(String branch)	Sets the value of CodeCommitSourceActionProps.getBranch()
CodeCommitSourceActionProps	build()	Builds the configured instance.
CodeCommitSourceActionProps.Builder	codeBuildCloneOutput(Boolean codeBuildCloneOutput)	Sets the value of CodeCommitSourceActionProps.getCodeBuildCloneOutput()
CodeCommitSourceActionProps.Builder	customEventRule(ICustomEventRule customEventRule)	Sets the value of CodeCommitSourceActionProps.getCustomEventRule()
CodeCommitSourceActionProps.Builder	eventRole(IRole eventRole)	Sets the value of CodeCommitSourceActionProps.getEventRole()
CodeCommitSourceActionProps.Builder	output(Artifact output)	Sets the value of CodeCommitSourceActionProps.getOutput()
CodeCommitSourceActionProps.Builder	repository(IRepository repository)	Sets the value of CodeCommitSourceActionProps.getRepository()
CodeCommitSourceActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
CodeCommitSourceActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
CodeCommitSourceActionProps.Builder	trigger(CodeCommitTrigger trigger)	Sets the value of CodeCommitSourceActionProps.getTrigger()
CodeCommitSourceActionProps.Builder	variablesNamespace(String variablesNamespace)	Sets the value of CommonActionProps.getVariablesNamespace()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

output

@Stability(Stable)
public CodeCommitSourceActionProps.Builder output(Artifact output)

Sets the value of CodeCommitSourceActionProps.getOutput()

Parameters:

output - the value to be set. This parameter is required.

Returns:

this

repository

@Stability(Stable)
public CodeCommitSourceActionProps.Builder repository(IRepository repository)

Sets the value of CodeCommitSourceActionProps.getRepository()

Parameters:

repository - The CodeCommit repository. This parameter is required.

Returns:

this

branch

@Stability(Stable)
public CodeCommitSourceActionProps.Builder branch(String branch)

Sets the value of CodeCommitSourceActionProps.getBranch()

Parameters:

branch - the value to be set.

Returns:

this

codeBuildCloneOutput

@Stability(Stable)
public CodeCommitSourceActionProps.Builder codeBuildCloneOutput(Boolean codeBuildCloneOutput)

Sets the value of CodeCommitSourceActionProps.getCodeBuildCloneOutput()

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. Note: if this option is true, then only CodeBuild actions can use the resulting output.

Returns:

this

customEventRule

@Stability(Stable)
public CodeCommitSourceActionProps.Builder customEventRule(ICustomEventRule customEventRule)

Sets the value of CodeCommitSourceActionProps.getCustomEventRule()

Parameters:

customEventRule - 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

Returns:

this

eventRole

@Stability(Stable)
public CodeCommitSourceActionProps.Builder eventRole(IRole eventRole)

Sets the value of CodeCommitSourceActionProps.getEventRole()

Parameters:

eventRole - Role to be used by on commit event rule. Used only when trigger value is CodeCommitTrigger.EVENTS.

Returns:

this

trigger

@Stability(Stable)
public CodeCommitSourceActionProps.Builder trigger(CodeCommitTrigger trigger)

Sets the value of CodeCommitSourceActionProps.getTrigger()

Parameters:

trigger - How should CodePipeline detect source changes for this Action.

Returns:

this

role

@Stability(Stable)
public CodeCommitSourceActionProps.Builder role(IRole role)

Sets the value of CommonAwsActionProps.getRole()

Parameters:

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 IAction.bind method in the ActionBindOptions.role property.

Returns:

this

actionName

@Stability(Stable)
public CodeCommitSourceActionProps.Builder actionName(String actionName)

Sets the value of CommonActionProps.getActionName()

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required. Note that Action names must be unique within a single Stage.

Returns:

this

runOrder

@Stability(Stable)
public CodeCommitSourceActionProps.Builder runOrder(Number runOrder)

Sets the value of CommonActionProps.getRunOrder()

Parameters:

runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Returns:

this

variablesNamespace

@Stability(Stable)
public CodeCommitSourceActionProps.Builder variablesNamespace(String variablesNamespace)

Sets the value of CommonActionProps.getVariablesNamespace()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CodeCommitSourceActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CodeCommitSourceActionProps

Throws:

NullPointerException - if any required attribute was not provided