CodeBuildStartBuildJsonPathProps Struct
Properties for CodeBuildStartBuild using JSONPath.
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 projectRef: interfaces_codebuild.IProjectRef;
declare const resultSelector: any;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
declare const value: any;
const codeBuildStartBuildJsonPathProps: stepfunctions_tasks.CodeBuildStartBuildJsonPathProps = {
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,
inputPath: 'inputPath',
integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
outputPath: 'outputPath',
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
resultPath: 'resultPath',
resultSelector: {
resultSelectorKey: resultSelector,
},
stateName: 'stateName',
taskTimeout: timeout,
timeout: cdk.Duration.minutes(30),
};
# 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
# project_ref: interfaces_codebuild.IProjectRef
# result_selector: Any
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout
# value: Any
code_build_start_build_json_path_props = stepfunctions_tasks.CodeBuildStartBuildJsonPathProps(
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,
input_path="inputPath",
integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
output_path="outputPath",
query_language=stepfunctions.QueryLanguage.JSON_PATH,
result_path="resultPath",
result_selector={
"result_selector_key": result_selector
},
state_name="stateName",
task_timeout=timeout,
timeout=cdk.Duration.minutes(30)
)
// 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;
IProjectRef projectRef;
Object resultSelector;
TaskRole taskRole;
Timeout timeout;
Object value;
CodeBuildStartBuildJsonPathProps codeBuildStartBuildJsonPathProps = CodeBuildStartBuildJsonPathProps.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)
.inputPath("inputPath")
.integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
.outputPath("outputPath")
.queryLanguage(QueryLanguage.JSON_PATH)
.resultPath("resultPath")
.resultSelector(Map.of(
"resultSelectorKey", resultSelector))
.stateName("stateName")
.taskTimeout(timeout)
.timeout(Duration.minutes(30))
.build();
// 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;
IProjectRef projectRef;
var resultSelector;
TaskRole taskRole;
Timeout timeout;
var value;
var codeBuildStartBuildJsonPathProps = new CodeBuildStartBuildJsonPathProps {
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,
InputPath = "inputPath",
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
OutputPath = "outputPath",
QueryLanguage = QueryLanguage.JSON_PATH,
ResultPath = "resultPath",
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
},
StateName = "stateName",
TaskTimeout = timeout,
Timeout = Duration.Minutes(30)
};
// 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 projectRef IProjectRef
var resultSelector interface{}
var taskRole TaskRole
var timeout Timeout
var value interface{}
codeBuildStartBuildJsonPathProps := &CodeBuildStartBuildJsonPathProps{
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,
InputPath: jsii.String("inputPath"),
IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
OutputPath: jsii.String("outputPath"),
QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
ResultPath: jsii.String("resultPath"),
ResultSelector: map[string]interface{}{
"resultSelectorKey": resultSelector,
},
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{}#Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#Default: No comment
credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials#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#Default: the latest environment variables already defined in the build project.
heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration= Nonedeprecated#heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout= None#[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string= $#May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern#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.
outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string= $#May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= JSONPath#If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string= $#May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*map[string]interface{}= None#You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#Default: The construct ID will be used as state name