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

Class CodeBuildStartBuildBatch

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.CodeBuildStartBuildBatch

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T13:52:12.819Z")
@Stability(Stable)
public class CodeBuildStartBuildBatch
extends TaskStateBase

Start a CodeBuild BatchBuild as a task.

Example:

 import software.amazon.awscdk.services.codebuild.*;
 Project project = Project.Builder.create(this, "Project")
         .projectName("MyTestProject")
         .buildSpec(BuildSpec.fromObjectToYaml(Map.of(
                 "version", 0.2,
                 "batch", Map.of(
                         "build-list", List.of(Map.of(
                                 "identifier", "id",
                                 "buildspec", "version: 0.2\nphases:\n  build:\n    commands:\n      - echo \"Hello, from small!\""))))))
         .build();
 project.enableBatchBuilds();
 CodeBuildStartBuildBatch task = CodeBuildStartBuildBatch.Builder.create(this, "buildBatchTask")
         .project(project)
         .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
         .environmentVariablesOverride(Map.of(
                 "test", BuildEnvironmentVariable.builder()
                         .type(BuildEnvironmentVariableType.PLAINTEXT)
                         .value("testValue")
                         .build()))
         .build();
 

See Also:

• https://docs.aws.amazon.com/codebuild/latest/APIReference/API_StartBuildBatch.html

Nested Class Summary

Nested Classes

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

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	CodeBuildStartBuildBatch(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CodeBuildStartBuildBatch(software.amazon.jsii.JsiiObjectRef objRef)
	CodeBuildStartBuildBatch(software.constructs.Construct scope, String id, CodeBuildStartBuildBatchProps props)

Method Summary

Modifier and Type	Method	Description
protected TaskMetricsConfig	getTaskMetrics()
protected List<PolicyStatement>	getTaskPolicies()
static CodeBuildStartBuildBatch	jsonata(software.constructs.Construct scope, String id, CodeBuildStartBuildBatchJsonataProps props)	Start a CodeBuild BatchBuild as a task using JSONata.
static CodeBuildStartBuildBatch	jsonPath(software.constructs.Construct scope, String id, CodeBuildStartBuildBatchJsonPathProps props)	Start a CodeBuild BatchBuild 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

CodeBuildStartBuildBatch

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

CodeBuildStartBuildBatch

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

CodeBuildStartBuildBatch

@Stability(Stable)
public CodeBuildStartBuildBatch(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CodeBuildStartBuildBatchProps 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 CodeBuildStartBuildBatch jsonata(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CodeBuildStartBuildBatchJsonataProps props)

Start a CodeBuild BatchBuild as a task using JSONata.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

See Also:

• https://docs.aws.amazon.com/codebuild/latest/APIReference/API_StartBuildBatch.html

jsonPath

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

Start a CodeBuild BatchBuild as a task using JSONPath.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

See Also:

• https://docs.aws.amazon.com/codebuild/latest/APIReference/API_StartBuildBatch.html

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