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

Class CodeBuildStartBuild

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.TaskStateBase

software.amazon.awscdk.services.stepfunctions.tasks.CodeBuildStartBuild

All Implemented Interfaces:

IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:51.366Z")
@Stability(Stable)
public class CodeBuildStartBuild
extends TaskStateBase

Start a CodeBuild Build as a task.

Example:

 import software.amazon.awscdk.services.codebuild.*;
 Project codebuildProject = Project.Builder.create(this, "Project")
         .projectName("MyTestProject")
         .buildSpec(BuildSpec.fromObject(Map.of(
                 "version", "0.2",
                 "phases", Map.of(
                         "build", Map.of(
                                 "commands", List.of("echo \"Hello, CodeBuild!\""))))))
         .build();
 CodeBuildStartBuild task = CodeBuildStartBuild.Builder.create(this, "Task")
         .project(codebuildProject)
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .environmentVariablesOverride(Map.of(
                 "ZONE", BuildEnvironmentVariable.builder()
                         .type(BuildEnvironmentVariableType.PLAINTEXT)
                         .value(JsonPath.stringAt("$.envVariables.zone"))
                         .build()))
         .build();
 

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-codebuild.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CodeBuildStartBuild.Builder	A fluent builder for CodeBuildStartBuild.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable

INextable.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CodeBuildStartBuild(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CodeBuildStartBuild(software.amazon.jsii.JsiiObjectRef objRef)
	CodeBuildStartBuild(software.constructs.Construct scope, String id, CodeBuildStartBuildProps props)

Method Summary

Modifier and Type	Method	Description
protected TaskMetricsConfig	getTaskMetrics()
protected List<PolicyStatement>	getTaskPolicies()
static CodeBuildStartBuild	jsonata(software.constructs.Construct scope, String id, CodeBuildStartBuildJsonataProps props)	Start a CodeBuild Build as a task using JSONata.
static CodeBuildStartBuild	jsonPath(software.constructs.Construct scope, String id, CodeBuildStartBuildJsonPathProps props)	Start a CodeBuild Build as a task using JSONPath.

Methods inherited from class software.amazon.awscdk.services.stepfunctions.TaskStateBase

addCatch, addCatch, addRetry, addRetry, getEndStates, metric, metric, metricFailed, metricFailed, metricHeartbeatTimedOut, metricHeartbeatTimedOut, metricRunTime, metricRunTime, metricScheduled, metricScheduled, metricScheduleTime, metricScheduleTime, metricStarted, metricStarted, metricSucceeded, metricSucceeded, metricTime, metricTime, metricTimedOut, metricTimedOut, next, toStateJson, toStateJson, whenBoundToGraph

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addChoice, addItemProcessor, addItemProcessor, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getArguments, getAssign, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getOutputs, getParameters, getProcessor, getProcessorConfig, getProcessorMode, getQueryLanguage, getResultPath, getResultSelector, getStartState, getStateId, getStateName, makeDefault, makeNext, prefixStates, renderAssign, renderAssign, renderBranches, renderChoices, renderChoices, renderInputOutput, renderItemProcessor, renderIterator, renderNextEnd, renderQueryLanguage, renderQueryLanguage, renderResultSelector, renderRetryCatch, renderRetryCatch, setDefaultChoice, setIteration, setProcessor, setProcessorConfig, setProcessorMode, validateState

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

CodeBuildStartBuild

protected CodeBuildStartBuild(software.amazon.jsii.JsiiObjectRef objRef)

CodeBuildStartBuild

protected CodeBuildStartBuild(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CodeBuildStartBuild

@Stability(Stable)
public CodeBuildStartBuild(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CodeBuildStartBuildProps props)

Parameters:

scope - This parameter is required.

id - Descriptive identifier for this chainable. This parameter is required.

props - This parameter is required.

Method Details

jsonata

@Stability(Stable)
@NotNull
public static CodeBuildStartBuild jsonata(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CodeBuildStartBuildJsonataProps props)

Start a CodeBuild Build as a task using JSONata.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

jsonPath

@Stability(Stable)
@NotNull
public static CodeBuildStartBuild jsonPath(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CodeBuildStartBuildJsonPathProps props)

Start a CodeBuild Build as a task using JSONPath.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

getTaskMetrics

@Stability(Stable)
@Nullable
protected TaskMetricsConfig getTaskMetrics()

Specified by:

getTaskMetrics in class TaskStateBase

getTaskPolicies

@Stability(Stable)
@Nullable
protected List<PolicyStatement> getTaskPolicies()

Specified by:

getTaskPolicies in class TaskStateBase