Skip to content
v2.277.0

CodeBuildStartBuildBatchJsonataProps Struct ​

Properties for CodeBuildStartBuildBatch using JSONata.

Example ​

ts
// 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),
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_codebuild as codebuild
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks
from aws_cdk.interfaces import aws_codebuild as interfaces_codebuild

# assign: Any
# outputs: Any
# project_ref: interfaces_codebuild.IProjectRef
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout
# value: Any

code_build_start_build_batch_jsonata_props = stepfunctions_tasks.CodeBuildStartBuildBatchJsonataProps(
    project=project_ref,

    # the properties below are optional
    assign={
        "assign_key": assign
    },
    comment="comment",
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    environment_variables_override={
        "environment_variables_override_key": codebuild.BuildEnvironmentVariable(
            value=value,

            # the properties below are optional
            type=codebuild.BuildEnvironmentVariableType.PLAINTEXT
        )
    },
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    outputs=outputs,
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    state_name="stateName",
    task_timeout=timeout,
    timeout=cdk.Duration.minutes(30)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.codebuild.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;
import software.amazon.awscdk.interfaces.codebuild.*;

Object assign;
Object outputs;
IProjectRef projectRef;
TaskRole taskRole;
Timeout timeout;
Object value;

CodeBuildStartBuildBatchJsonataProps codeBuildStartBuildBatchJsonataProps = CodeBuildStartBuildBatchJsonataProps.builder()
        .project(projectRef)

        // the properties below are optional
        .assign(Map.of(
                "assignKey", assign))
        .comment("comment")
        .credentials(Credentials.builder()
                .role(taskRole)
                .build())
        .environmentVariablesOverride(Map.of(
                "environmentVariablesOverrideKey", BuildEnvironmentVariable.builder()
                        .value(value)

                        // the properties below are optional
                        .type(BuildEnvironmentVariableType.PLAINTEXT)
                        .build()))
        .heartbeat(Duration.minutes(30))
        .heartbeatTimeout(timeout)
        .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
        .outputs(outputs)
        .queryLanguage(QueryLanguage.JSON_PATH)
        .stateName("stateName")
        .taskTimeout(timeout)
        .timeout(Duration.minutes(30))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.CodeBuild;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
using Amazon.CDK.Interfaces.CodeBuild;

var assign;
var outputs;
IProjectRef projectRef;
TaskRole taskRole;
Timeout timeout;
var value;

var codeBuildStartBuildBatchJsonataProps = new CodeBuildStartBuildBatchJsonataProps {
    Project = projectRef,

    // the properties below are optional
    Assign = new Dictionary<string, object> {
        { "assignKey", assign }
    },
    Comment = "comment",
    Credentials = new Credentials {
        Role = taskRole
    },
    EnvironmentVariablesOverride = new Dictionary<string, BuildEnvironmentVariable> {
        { "environmentVariablesOverrideKey", new BuildEnvironmentVariable {
            Value = value,

            // the properties below are optional
            Type = BuildEnvironmentVariableType.PLAINTEXT
        } }
    },
    Heartbeat = Duration.Minutes(30),
    HeartbeatTimeout = timeout,
    IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
    Outputs = outputs,
    QueryLanguage = QueryLanguage.JSON_PATH,
    StateName = "stateName",
    TaskTimeout = timeout,
    Timeout = Duration.Minutes(30)
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var assign interface{}
var outputs interface{}
var projectRef IProjectRef
var taskRole TaskRole
var timeout Timeout
var value interface{}

codeBuildStartBuildBatchJsonataProps := &CodeBuildStartBuildBatchJsonataProps{
	Project: projectRef,

	// the properties below are optional
	Assign: map[string]interface{}{
		"assignKey": assign,
	},
	Comment: jsii.String("comment"),
	Credentials: &Credentials{
		Role: taskRole,
	},
	EnvironmentVariablesOverride: map[string]BuildEnvironmentVariable{
		"environmentVariablesOverrideKey": &BuildEnvironmentVariable{
			"value": value,

			// the properties below are optional
			"type": awscdk.aws_codebuild.BuildEnvironmentVariableType_PLAINTEXT,
		},
	},
	Heartbeat: cdk.Duration_Minutes(jsii.Number(30)),
	HeartbeatTimeout: timeout,
	IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
	Outputs: outputs,
	QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
	StateName: jsii.String("stateName"),
	TaskTimeout: timeout,
	Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
}

Properties ​

assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*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.

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#
A comment describing this state.

Default: No comment

credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials#
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.

environmentVariablesOverrideoptional{ [key: string]: BuildEnvironmentVariable }environment_variables_overrideoptionaltyping.Mapping[str, BuildEnvironmentVariable]environmentVariablesOverrideoptionalMap<String, BuildEnvironmentVariable>EnvironmentVariablesOverrideoptionalIDictionary<string, BuildEnvironmentVariable>EnvironmentVariablesOverrideoptional*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.

heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration= Nonedeprecated#
use `heartbeatTimeout`
heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout= None#
Timeout for the heartbeat.

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

integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern#
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.

outputsoptionalanyoutputsoptionalAnyoutputsoptionalObjectOutputsoptionalobjectOutputsoptionalinterface{}#
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.
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= 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.

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#
Optional name for this state.

Default: The construct ID will be used as state name

taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout= None#
Timeout for the task.

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

timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Nonedeprecated#
use `taskTimeout`