Package software.amazon.awscdk.services.stepfunctions.tasks

Class CodeBuildStartBuildProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.CodeBuildStartBuildProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CodeBuildStartBuildProps>

Enclosing interface:

CodeBuildStartBuildProps

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

A builder for CodeBuildStartBuildProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CodeBuildStartBuildProps	build()	Builds the configured instance.
CodeBuildStartBuildProps.Builder	comment(String comment)	Sets the value of TaskStateBaseProps.getComment()
CodeBuildStartBuildProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseProps.getCredentials()
CodeBuildStartBuildProps.Builder	environmentVariablesOverride(Map<String,? extends BuildEnvironmentVariable> environmentVariablesOverride)	Sets the value of CodeBuildStartBuildProps.getEnvironmentVariablesOverride()
CodeBuildStartBuildProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
CodeBuildStartBuildProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseProps.getHeartbeatTimeout()
CodeBuildStartBuildProps.Builder	inputPath(String inputPath)	Sets the value of TaskStateBaseProps.getInputPath()
CodeBuildStartBuildProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseProps.getIntegrationPattern()
CodeBuildStartBuildProps.Builder	outputPath(String outputPath)	Sets the value of TaskStateBaseProps.getOutputPath()
CodeBuildStartBuildProps.Builder	project(IProject project)	Sets the value of CodeBuildStartBuildProps.getProject()
CodeBuildStartBuildProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
CodeBuildStartBuildProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
CodeBuildStartBuildProps.Builder	stateName(String stateName)	Sets the value of TaskStateBaseProps.getStateName()
CodeBuildStartBuildProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseProps.getTaskTimeout()
CodeBuildStartBuildProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`

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

project

@Stability(Stable)
public CodeBuildStartBuildProps.Builder project(IProject project)

Sets the value of CodeBuildStartBuildProps.getProject()

Parameters:

project - CodeBuild project to start. This parameter is required.

Returns:

this

environmentVariablesOverride

@Stability(Stable)
public CodeBuildStartBuildProps.Builder environmentVariablesOverride(Map<String,? extends BuildEnvironmentVariable> environmentVariablesOverride)

Sets the value of CodeBuildStartBuildProps.getEnvironmentVariablesOverride()

Parameters:

environmentVariablesOverride - A set of environment variables to be used for this build only.

Returns:

this

comment

@Stability(Stable)
public CodeBuildStartBuildProps.Builder comment(String comment)

Sets the value of TaskStateBaseProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

credentials

@Stability(Stable)
public CodeBuildStartBuildProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseProps.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

@Stability(Deprecated)
@Deprecated
public CodeBuildStartBuildProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseProps.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public CodeBuildStartBuildProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseProps.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

inputPath

@Stability(Stable)
public CodeBuildStartBuildProps.Builder inputPath(String inputPath)

Sets the value of TaskStateBaseProps.getInputPath()

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

this

integrationPattern

@Stability(Stable)
public CodeBuildStartBuildProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseProps.getIntegrationPattern()

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

this

outputPath

@Stability(Stable)
public CodeBuildStartBuildProps.Builder outputPath(String outputPath)

Sets the value of TaskStateBaseProps.getOutputPath()

Parameters:

outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

resultPath

@Stability(Stable)
public CodeBuildStartBuildProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.getResultPath()

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

this

resultSelector

@Stability(Stable)
public CodeBuildStartBuildProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateBaseProps.getResultSelector()

Parameters:

resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

this

stateName

@Stability(Stable)
public CodeBuildStartBuildProps.Builder stateName(String stateName)

Sets the value of TaskStateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

taskTimeout

@Stability(Stable)
public CodeBuildStartBuildProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseProps.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

@Stability(Deprecated)
@Deprecated
public CodeBuildStartBuildProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseProps.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

build

@Stability(Stable)
public CodeBuildStartBuildProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CodeBuildStartBuildProps

Throws:

NullPointerException - if any required attribute was not provided