software.amazon.awscdk.services.codepipeline.actions

Class CodeBuildActionProps.Builder

java.lang.Object

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

Enclosing interface:

CodeBuildActionProps

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

A builder for CodeBuildActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CodeBuildActionProps.Builder	actionName(String actionName) Sets the value of ActionName
CodeBuildActionProps	build() Builds the configured instance.
CodeBuildActionProps.Builder	environmentVariables(Map<String,BuildEnvironmentVariable> environmentVariables) Sets the value of EnvironmentVariables
CodeBuildActionProps.Builder	extraInputs(List<Artifact> extraInputs) Sets the value of ExtraInputs
CodeBuildActionProps.Builder	input(Artifact input) Sets the value of Input
CodeBuildActionProps.Builder	outputs(List<Artifact> outputs) Sets the value of Outputs
CodeBuildActionProps.Builder	project(IProject project) Sets the value of Project
CodeBuildActionProps.Builder	role(IRole role) Sets the value of Role
CodeBuildActionProps.Builder	runOrder(Number runOrder) Sets the value of RunOrder
CodeBuildActionProps.Builder	type(CodeBuildActionType type) Sets the value of Type

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

input

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

Sets the value of Input

Parameters:

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

Returns:

this

project

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

Sets the value of Project

Parameters:

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

Returns:

this

environmentVariables

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

Sets the value of 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.

Returns:

this

extraInputs

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

Sets the value of ExtraInputs

Parameters:

extraInputs - The list of additional input Artifacts for this action.

Returns:

this

outputs

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

Sets the value of 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.

Returns:

this

type

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

Sets the value of Type

Parameters:

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

Returns:

this

role

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

Sets the value of 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.

Returns:

this

actionName

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

Sets the value of 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 CodeBuildActionProps.Builder runOrder(Number runOrder)

Sets the value of RunOrder

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Returns:

a new instance of CodeBuildActionProps

Throws:

NullPointerException - if any required attribute was not provided