Skip to content
v2.277.0

EmrAddStepJsonPathProps Struct ​

Properties for EmrAddStep using JSONPath.

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_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const assign: any;
declare const resultSelector: any;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const emrAddStepJsonPathProps: stepfunctions_tasks.EmrAddStepJsonPathProps = {
  clusterId: 'clusterId',
  jar: 'jar',
  name: 'name',

  // the properties below are optional
  actionOnFailure: stepfunctions_tasks.ActionOnFailure.TERMINATE_CLUSTER,
  args: ['args'],
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  executionRoleArn: 'executionRoleArn',
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  mainClass: 'mainClass',
  outputPath: 'outputPath',
  properties: {
    propertiesKey: 'properties',
  },
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  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_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks

# assign: Any
# result_selector: Any
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout

emr_add_step_json_path_props = stepfunctions_tasks.EmrAddStepJsonPathProps(
    cluster_id="clusterId",
    jar="jar",
    name="name",

    # the properties below are optional
    action_on_failure=stepfunctions_tasks.ActionOnFailure.TERMINATE_CLUSTER,
    args=["args"],
    assign={
        "assign_key": assign
    },
    comment="comment",
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    execution_role_arn="executionRoleArn",
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    input_path="inputPath",
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    main_class="mainClass",
    output_path="outputPath",
    properties={
        "properties_key": "properties"
    },
    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)
)
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.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;

Object assign;
Object resultSelector;
TaskRole taskRole;
Timeout timeout;

EmrAddStepJsonPathProps emrAddStepJsonPathProps = EmrAddStepJsonPathProps.builder()
        .clusterId("clusterId")
        .jar("jar")
        .name("name")

        // the properties below are optional
        .actionOnFailure(ActionOnFailure.TERMINATE_CLUSTER)
        .args(List.of("args"))
        .assign(Map.of(
                "assignKey", assign))
        .comment("comment")
        .credentials(Credentials.builder()
                .role(taskRole)
                .build())
        .executionRoleArn("executionRoleArn")
        .heartbeat(Duration.minutes(30))
        .heartbeatTimeout(timeout)
        .inputPath("inputPath")
        .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
        .mainClass("mainClass")
        .outputPath("outputPath")
        .properties(Map.of(
                "propertiesKey", "properties"))
        .queryLanguage(QueryLanguage.JSON_PATH)
        .resultPath("resultPath")
        .resultSelector(Map.of(
                "resultSelectorKey", resultSelector))
        .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.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;

var assign;
var resultSelector;
TaskRole taskRole;
Timeout timeout;

var emrAddStepJsonPathProps = new EmrAddStepJsonPathProps {
    ClusterId = "clusterId",
    Jar = "jar",
    Name = "name",

    // the properties below are optional
    ActionOnFailure = ActionOnFailure.TERMINATE_CLUSTER,
    Args = new [] { "args" },
    Assign = new Dictionary<string, object> {
        { "assignKey", assign }
    },
    Comment = "comment",
    Credentials = new Credentials {
        Role = taskRole
    },
    ExecutionRoleArn = "executionRoleArn",
    Heartbeat = Duration.Minutes(30),
    HeartbeatTimeout = timeout,
    InputPath = "inputPath",
    IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
    MainClass = "mainClass",
    OutputPath = "outputPath",
    Properties = new Dictionary<string, string> {
        { "propertiesKey", "properties" }
    },
    QueryLanguage = QueryLanguage.JSON_PATH,
    ResultPath = "resultPath",
    ResultSelector = new Dictionary<string, object> {
        { "resultSelectorKey", resultSelector }
    },
    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"

var assign interface{}
var resultSelector interface{}
var taskRole TaskRole
var timeout Timeout

emrAddStepJsonPathProps := &EmrAddStepJsonPathProps{
	ClusterId: jsii.String("clusterId"),
	Jar: jsii.String("jar"),
	Name: jsii.String("name"),

	// the properties below are optional
	ActionOnFailure: awscdk.Aws_stepfunctions_tasks.ActionOnFailure_TERMINATE_CLUSTER,
	Args: []*string{
		jsii.String("args"),
	},
	Assign: map[string]interface{}{
		"assignKey": assign,
	},
	Comment: jsii.String("comment"),
	Credentials: &Credentials{
		Role: taskRole,
	},
	ExecutionRoleArn: jsii.String("executionRoleArn"),
	Heartbeat: cdk.Duration_Minutes(jsii.Number(30)),
	HeartbeatTimeout: timeout,
	InputPath: jsii.String("inputPath"),
	IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
	MainClass: jsii.String("mainClass"),
	OutputPath: jsii.String("outputPath"),
	Properties: map[string]*string{
		"propertiesKey": jsii.String("properties"),
	},
	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 ​

actionOnFailureoptionalActionOnFailureaction_on_failureoptionalActionOnFailureactionOnFailureoptionalActionOnFailureActionOnFailureoptionalActionOnFailureActionOnFailureoptionalActionOnFailure = ActionOnFailure.CONTINUE #
The action to take when the cluster step fails.
argsoptionalstring[]argsoptionaltyping.List[str]argsoptionalList<String>Argsoptionalstring[]Argsoptional*[]*string #
A list of command line arguments passed to the JAR file's main function when executed.

Default: No args

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.

clusterIdstringcluster_idstrclusterIdStringClusterIdstringClusterId*string required #
The ClusterId to add the Step to.
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.

executionRoleArnoptionalstringexecution_role_arnoptionalstrexecutionRoleArnoptionalStringExecutionRoleArnoptionalstringExecutionRoleArnoptional*string #
The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.

Default: Uses EC2 instance profile role

heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration = None deprecated #
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

inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string = $ #
JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

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.

jarstringjarstrjarStringJarstringJar*string required #
A path to a JAR file run during the step.
mainClassoptionalstringmain_classoptionalstrmainClassoptionalStringMainClassoptionalstringMainClassoptional*string #
The name of the main class in the specified Java file.

Default: No mainClass

If not specified, the JAR file should specify a Main-Class in its manifest file.

namestringnamestrnameStringNamestringName*string required #
The name of the Step.
outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string = $ #
JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

propertiesoptional{ [key: string]: string }propertiesoptionaltyping.Mapping[str, str]propertiesoptionalMap<String, String>PropertiesoptionalIDictionary<string, string>Propertiesoptional*map[string]*string #
A list of Java properties that are set when the step runs.

Default: No properties

You can use these properties to pass key value pairs to your main function.

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.

resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string = $ #
JSONPath expression to indicate where to inject the state's output.

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 #
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

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 = None deprecated #
use `taskTimeout`