aws-cdk-lib.aws_stepfunctions_tasks.CodeBuildStartBuildBatchJsonataProps

CodeBuildStartBuildBatchJsonataProps Struct

Properties for CodeBuildStartBuildBatch using JSONata.

CodeBuildStartBuildBatchJsonataProps

extends

• TaskStateJsonataBaseProps

Source

aws-stepfunctions-tasks/lib/codebuild/start-build-batch.ts

Type last changed

v2.234.0 · 8 Jan 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';
import { aws_codebuild as interfaces_codebuild } from 'aws-cdk-lib/interfaces';

declare const assign: any;
declare const outputs: any;
declare const projectRef: interfaces_codebuild.IProjectRef;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
declare const value: any;
const codeBuildStartBuildBatchJsonataProps: stepfunctions_tasks.CodeBuildStartBuildBatchJsonataProps = {
  project: projectRef,

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  environmentVariablesOverride: {
    environmentVariablesOverrideKey: {
      value: value,

      // the properties below are optional
      type: codebuild.BuildEnvironmentVariableType.PLAINTEXT,
    },
  },
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputs: outputs,
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};

Properties

assign{ [key: string]: any }assigntyping.Mapping[str, Any]assignMap<String, Object>AssignIDictionary<string, object>Assign*map[string]interface{}#

Workflow variables to store in this step.

Default: Not assign variables

Using workflow variables, you can store data in a step and retrieve that data in future steps.

commentstringcommentstrcommentStringCommentstringComment*string#

A comment describing this state.

Default: No comment

credentialsCredentialscredentialsCredentialscredentialsCredentialsCredentialsCredentialsCredentialsCredentials#

Credentials for an IAM Role that the State Machine assumes for executing the task.

Default: None (Task is executed using the State Machine's execution role)

This enables cross-account resource invocations.

environmentVariablesOverride{ [key: string]: BuildEnvironmentVariable }environment_variables_overridetyping.Mapping[str, BuildEnvironmentVariable]environmentVariablesOverrideMap<String, BuildEnvironmentVariable>EnvironmentVariablesOverrideIDictionary<string, BuildEnvironmentVariable>EnvironmentVariablesOverride*map[string]BuildEnvironmentVariable#

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

Default: the latest environment variables already defined in the build project.

heartbeatDurationheartbeatDurationheartbeatDurationHeartbeatDurationHeartbeatDuration= Nonedeprecated#

use `heartbeatTimeout`

heartbeatTimeoutTimeoutheartbeat_timeoutTimeoutheartbeatTimeoutTimeoutHeartbeatTimeoutTimeoutHeartbeatTimeoutTimeout= None#

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

integrationPatternIntegrationPatternintegration_patternIntegrationPatternintegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPattern#

AWS Step Functions integrates with services directly in the Amazon States Language.

Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

You can control these AWS services using service integration patterns.

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

outputsanyoutputsAnyoutputsObjectOutputsobjectOutputsinterface{}#

Used to specify and transform output from the state.

Default: $states.result or $states.errorOutput

notes

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

projectIProjectRefprojectIProjectRefprojectIProjectRefProjectIProjectRefProjectIProjectRefrequired#

CodeBuild project to start.

queryLanguageQueryLanguagequery_languageQueryLanguagequeryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguage= JSONPath#

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

stateNamestringstate_namestrstateNameStringStateNamestringStateName*string#

Optional name for this state.

Default: The construct ID will be used as state name

taskTimeoutTimeouttask_timeoutTimeouttaskTimeoutTimeoutTaskTimeoutTimeoutTaskTimeoutTimeout= None#

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= Nonedeprecated#

use `taskTimeout`