software.amazon.awscdk.services.codepipeline.actions

Class CodeBuildAction.Builder

java.lang.Object

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

Enclosing class:

CodeBuildAction

@Stability(value=Stable)
public static final class CodeBuildAction.Builder
extends Object

A fluent builder for CodeBuildAction.

Method Summary

Modifier and Type	Method and Description
CodeBuildAction.Builder	actionName(String actionName)
CodeBuildAction	build()
static CodeBuildAction.Builder	create()
CodeBuildAction.Builder	environmentVariables(Map<String,BuildEnvironmentVariable> environmentVariables)
CodeBuildAction.Builder	extraInputs(List<Artifact> extraInputs)
CodeBuildAction.Builder	input(Artifact input)
CodeBuildAction.Builder	outputs(List<Artifact> outputs)
CodeBuildAction.Builder	project(IProject project)
CodeBuildAction.Builder	role(IRole role)
CodeBuildAction.Builder	runOrder(Number runOrder)
CodeBuildAction.Builder	type(CodeBuildActionType type)

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 CodeBuildAction.Builder create()

Returns:

a new instance of CodeBuildAction.Builder.

actionName

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

Parameters:

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

Returns:

this

runOrder

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

Parameters:

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

Returns:

this

role

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

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

Returns:

this

input

@Stability(value=Stable)
public CodeBuildAction.Builder input(Artifact input)

Parameters:

input - The source to use as input for this action. This parameter is required.

Returns:

this

project

@Stability(value=Stable)
public CodeBuildAction.Builder project(IProject project)

Parameters:

project - The action's Project. This parameter is required.

Returns:

this

environmentVariables

@Stability(value=Stable)
public CodeBuildAction.Builder environmentVariables(Map<String,BuildEnvironmentVariable> environmentVariables)

Parameters:

environmentVariables - The environment variables to pass to the CodeBuild project when this action executes. If a variable with the same name was set both on the project level, and here, this value will take precedence. This parameter is required.

Returns:

this

extraInputs

@Stability(value=Stable)
public CodeBuildAction.Builder extraInputs(List<Artifact> extraInputs)

Parameters:

extraInputs - The list of additional input Artifacts for this action. This parameter is required.

Returns:

this

outputs

@Stability(value=Stable)
public CodeBuildAction.Builder outputs(List<Artifact> outputs)

Parameters:

outputs - The list of output Artifacts for this action. **Note**: if you specify more than one output Artifact here, you cannot use the primary 'artifacts' section of the buildspec; you have to use the 'secondary-artifacts' section instead. See https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html for details. This parameter is required.

Returns:

this

type

@Stability(value=Stable)
public CodeBuildAction.Builder type(CodeBuildActionType type)

Parameters:

type - The type of the action that determines its CodePipeline Category - Build, or Test. This parameter is required.

Returns:

this

build

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